<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <style xmlns="" type="text/css">
    /* This style sets a margin around the entire page */
        html, body {
            margin: 10px;
        }

        p {
            font: normal 16px verdana, sans-serif;
            margin: 0;
            padding-bottom:12px;
        }

        h1 {
            font: bold 25px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h2 {
            font: bold 19px verdana, sans-serif;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h3 {
            font: bold 19px verdana, sans-serif !important;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        li {
            font: normal 16px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 18px;
            padding-top: 0;
            padding-bottom: 0;
        }

        .pdparam {
            font: italic 16px verdana, sans-serif;
        }

                .term {
                        font: italic 16px verdana, sans-serif;
                        font-weight: normal;
                }

                .type {
                        font: normal 16px verdana, sans-serif !important;
                }

                .parameter {
                        font-style: italic;
                        }

        a:link, a:visited {
            color: blue;
            text-decoration: none;
            font: normal 16px;
        }

        a:hover {
            background-color: #FFFF99;
            font: normal 16px;
        }

        div.funcsynopsis {
            text-align: left;
            background-color: #e6e6e6;
            font: normal 16px verdana, sans-serif;
                        padding-top: 10px;
                        padding-bottom: 10px;
        }

        div.funcsynopsis table {
            border-collapse: separate;
            font: normal 16px verdana, sans-serif;
        }

        div.funcsynopsis td {
            background-color: #e6e6e6;
            border: 0 solid #000;
            padding: 1px;
            font: normal 16px verdana, sans-serif;
        }

        div.refsect1 {
            font-family: verdana, sans-serif;
            font-size: 16px;
        }

        code.constant {
            font: normal 16px courier new, monospace !important;
        }

                span.errorname {
            font: normal 16px verdana, sans-serif !important;
        }

        code.function {
            font: bold 16px verdana, sans-serif !important;
        }

        b.fsfunc {
            font: bold 16px verdana, sans-serif !important;
        }

        code.varname {
            font: italic 16px verdana, sans-serif;
        }

        code.replaceable {
            font: italic 16px courier new, monospace;
        }

        code.funcdef {
            font: normal 16px verdana, sans-serif !important;
        }

        .citerefentry {
            font: normal 16px verdana, sans-serif !important;
        }

        .parameter {
            font-style: italic;
        }

        code.fsfunc {
            font: normal 16px verdana, sans-serif !important;
        }

        /* PARAMETER: This style controls spacing between the terms in Parameter section */
        dt {
            margin-top: 15px;
        }

        /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
        div.refsect1 table {
            width: 100%;
                        margin-top: 10px;
            background-color: #FFF;
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
                        font: normal 16px verdana, sans-serif;
        }

        div.refsect1 th {
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
            font: bold 16px verdana, sans-serif;
        }

        div.refsect1 td {
            background-color: #FFF;
            padding: 5px;
            vertical-align: text-top;
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
            font: normal 16px verdana, sans-serif;
        }

                  div.refsect1 p{
            font: normal 16px verdana, sans-serif;
            margin-top: 8px;
            margin-bottom: 8px;
            padding-top: 0;
            padding-bottom: 0;
        }


        /* EXAMPLE: These styles apply only to the Example section */
        div.refsect2 {
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 table {
            margin-top: 0;
            background-color: #e6e6e6;
            width: 100%;
            border: 0 solid #000;
            padding: 2px;
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 td {
            background-color: #e6e6e6;
            font: normal 16px courier new, monospace !important;
                        white-space:pre;
        }

        /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
        div.refsect3 {
            font: normal 11px verdana, sans-serif;
            margin-top: 50px;
            margin-bottom: 20px;
            padding-top: 0;
            padding-bottom: 0;
        }

</style>
    <title>clCreateFromGLTexture</title>
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
    <meta name="keywords" content="clCreateFromGLTexture" />
  </head>
  <body>
    <div class="refentry">
      <a id="id-1"></a>
      <div class="titlepage"></div>
      <div xmlns="" class="refnamediv">
        <a xmlns="http://www.w3.org/1999/xhtml" id="clCreateFromGLTexture"></a>
        <h1>clCreateFromGLTexture</h1>
        <p>
             Creates an OpenCL image object, image array object, or image buffer object from an OpenGL texture object,
             texture array object, texture buffer object, or a single face of an OpenGL cubemap texture object.
        </p>
      </div>
      <div class="refsynopsisdiv">
        <h2></h2>
        <div class="funcsynopsis">
          <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
            <tr valign="bottom">
              <td>
                <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef"><a class="link" href="abstractDataTypes.html" target="pagedisplay">cl_mem</a>
                    <strong class="fsfunc">
                        clCreateFromGLTexture
                    </strong>
                (</code>
                <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_context</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">context</var>, </td>
              </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_mem_flags" target="pagedisplay">cl_mem_flags</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">flags</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>GLenum <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">texture_target</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>GLint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">miplevel</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>GLuint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">texture</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_int</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">* errcode_ret</var><code>)</code></td>
            </tr>
          </table>
        </div>
      </div>
      <div class="refsect1">
        <a id="parameters"></a>
        <h2>Parameters</h2>
        <div class="variablelist">
          <dl class="variablelist">
            <dt>
              <span class="term"> <code class="varname"> context </code> </span>
            </dt>
            <dd>
              <p> 
                        A valid OpenCL context created from an OpenGL context.
                    </p>
            </dd>
            <dt>
              <span class="term"> <code class="varname"> flags </code> </span>
            </dt>
            <dd>
              <p>
                       A bit-field that is used to
                      specify usage information. Refer to the table   for
                      <code class="function"><a class="citerefentry" href="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a></code> for a description of <code class="varname">flags</code>. Only the values
                      <code class="constant">CL_MEM_READ_ONLY</code>, <code class="constant">CL_MEM_WRITE_ONLY</code>
                      and <code class="constant">CL_MEM_READ_WRITE</code>  can be used.
                    </p>
            </dd>
            <dt>
              <span class="term"> <code class="varname"> texture_target </code> </span>
            </dt>
            <dd>
              <p>
                       <code class="varname">texture_target</code>
                      This value must be one of <code class="constant">GL_TEXTURE_1D</code>,
                      <code class="constant">GL_TEXTURE_1D_ARRAY</code>,
                      <code class="constant">GL_TEXTURE_BUFFER</code>, <code class="constant">GL_TEXTURE_2D</code>,
                      <code class="constant">GL_TEXTURE_2D_ARRAY</code>, <code class="constant">GL_TEXTURE_3D</code>,
                      <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_X</code>,
                      <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Y</code>,
                      <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Z</code>,
                      <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_X</code>,
                      <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</code>,
                      <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</code>, or
                      <code class="constant">GL_TEXTURE_RECTANGLE</code>.  This requires OpenGL 3.1.
                      Alternatively, <code class="constant">GL_TEXTURE_RECTANGLE_ARB</code> may be
                      specified if the OpenGL extension GL_ARB_texture_rectangle is supported.
                      <code class="varname">texture_target</code> is used only to define the image type
                      of <code class="varname">texture</code>.  No reference to a bound GL texture object
                      is made or implied by this parameter.
                    </p>
            </dd>
            <dt>
              <span class="term"> <code class="varname"> miplevel </code> </span>
            </dt>
            <dd>
              <p>
                       The mipmap level to be used. If
                      <code class="varname">texture_target</code> is <code class="constant">GL_TEXTURE_BUFFER</code>,
                      miplevel must be 0. Implementations may return
                      <code class="constant">CL_INVALID_OPERATION</code> for miplevel values &gt; 0
                    </p>
            </dd>
            <dt>
              <span class="term"> <code class="varname"> texture </code> </span>
            </dt>
            <dd>
              <p>
                       The name of a GL 1D, 2D, 3D, 1D array,
                      2D array, cubemap, rectangle or buffer texture object. The texture object
                      must be a complete texture as per OpenGL rules on texture completeness. The
                      <code class="varname">texture</code> format and dimensions defined by OpenGL for the
                      specified <code class="varname">miplevel</code> of the texture will be used to create
                      the OpenCL image memory object. Only GL texture objects with an internal
                      format that maps to appropriate image channel order and data type specified
                      in tables 5.5 and 5.6 may be used to create the OpenCL image memory object.
                    </p>
            </dd>
            <dt>
              <span class="term"> <code class="varname"> errcode_ret </code> </span>
            </dt>
            <dd>
              <p>
                       Returns an appropriate error code as described
                      below.  If <code class="varname">errcode_ret</code> is NULL, no error code is returned.
                    </p>
            </dd>
          </dl>
        </div>
      </div>
      <div class="refsect1">
        <a id="notes"></a>
        <h2>Notes</h2>
        <p>
          If the state of a GL texture object is modified through the GL API
          (e.g. <code class="function">glTexImage2D</code>, <code class="function">glTexImage3D</code> or
          the values of the texture parameters <code class="constant">GL_TEXTURE_BASE_LEVEL</code>
          or <code class="constant">GL_TEXTURE_MAX_LEVEL</code> are modified) while there exists a
          corresponding CL image object, subsequent use of the CL image object will result in
          undefined behavior.
        </p>
        <p>
          The <a class="citerefentry" href="clRetainMemObject.html"><span class="citerefentry"><span class="refentrytitle">clRetainMemObject</span></span></a>
          and <a class="citerefentry" href="clReleaseMemObject.html"><span class="citerefentry"><span class="refentrytitle">clReleaseMemObject</span></span></a>
          functions can be used to retain and release the image objects.
        </p>
      </div>
      <div class="refsect1">
        <a id="errors"></a>
        <h2>Errors</h2>
        <p>
          Returns a valid non-zero OpenCL image object and <code class="varname">errcode_ret</code>
          is set to <span class="errorname">CL_SUCCESS</span> if the image object is created
          successfully. Otherwise, it returns a NULL value with one of the following error
          values returned in <code class="varname">errcode_ret</code>:
        </p>
        <div class="itemizedlist">
          <ul class="itemizedlist" style="list-style-type: disc; ">
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_CONTEXT</span> if <code class="varname">context</code> is not
              a valid context or was not created from a GL context.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if values specified in
              <code class="varname">flags</code> are not valid or if value specified in
              <code class="varname">texture_target</code> is not one of the values specified in the
              description of <code class="varname">texture_target</code>.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_MIP_LEVEL</span> if <code class="varname">miplevel</code>
              is less than the value of <code class="varname">level<sub>base</sub></code>
              (for OpenGL implementations) or zero (for OpenGL ES implementations); or
              greater than the value of <code class="varname">q</code> (for both OpenGL and OpenGL
              ES). <code class="varname">level<sub>base</sub></code> and <code class="varname">q</code>
              are defined for the texture in section 3.8.10 (Texture Completeness) of the OpenGL
              2.1 specification and section 3.7.10 of the OpenGL ES 2.0.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_MIP_LEVEL</span> if <code class="varname">miplevel</code> is
              greater than zero and the OpenGL implementation does not support creating from
              non-zero mipmap levels.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_GL_OBJECT</span> if <code class="varname">texture</code> is not
              a GL texture object whose type matches <code class="varname">texture_target</code>, if the
              specified <code class="varname">miplevel</code> of <code class="varname">texture</code> is not defined,
              or if the width or height of the specified <code class="varname">miplevel</code> is zero.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_IMAGE_FORMAT_DESCRIPTOR</span> if the OpenGL texture
              internal format does not map to a supported OpenCL image format.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_OPERATION</span> if texture is a GL texture object
              created with a border width value greater than zero.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_RESOURCES</span> if there is a failure to allocate
              resources required by the OpenCL implementation on the device.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_HOST_MEMORY</span> if there is a failure to allocate
              resources required by the OpenCL implementation on the host.
            </li>
          </ul>
        </div>
      </div>
      <div class="refsect1">
        <a id="specification"></a>
        <h2>Specification</h2>
        <p>
            <img src="pdficon_small1.gif" />

            <a href="http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf#page=50" target="OpenCL Spec">OpenCL Specification</a>
        </p>
      </div>
      <div class="refsect1"><a id="seealso"></a><h2>Also see</h2>
    obsolete page replaced by clCreateFromGLTexture
        <p>
            <a class="citerefentry" href="cl_khr_gl_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_gl_sharing</span></span></a>,
            <a class="citerefentry" href="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a>,
            <a class="citerefentry" href="clCreateFromGLTexture.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromGLTexture</span></span></a>
        </p></div>
      <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2011 The Khronos Group Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.
</div>
    </div>
  </body>
</html>
